<!--
  ~ Copyright (C) 2010 Brockmann Consult GmbH (info@brockmann-consult.de)
  ~
  ~ This program is free software; you can redistribute it and/or modify it
  ~ under the terms of the GNU General Public License as published by the Free
  ~ Software Foundation; either version 3 of the License, or (at your option)
  ~ any later version.
  ~ This program is distributed in the hope that it will be useful, but WITHOUT
  ~ ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  ~ FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
  ~ more details.
  ~
  ~ You should have received a copy of the GNU General Public License along
  ~ with this program; if not, see http://www.gnu.org/licenses/
  -->

<html>
<head>
    <title>Sentinel Toolbox Help - Correlative Plot</title>
    <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
    <link rel="stylesheet" href="../style.css">
</head>

<body>

<table class="header">
    <tr class="header">
        <td class="header">&nbsp;
            Correlative Plot
        </td>
        <td class="header" align="right"><a href="../general/overview/SnapOverview.html"><img
                src="../images/snap_header.jpg" border=0></a></td>
    </tr>
</table>


<h3>Correlative Plot Display</h3>

<p>
    This dialog allows you to plot an imported variable (e.g. a ship track with in situ measurements)
    against a raster variable.
    In order to plot them, these variables must be already imported into the product which contains the
    correlative raster data via <a href="VectorDataManagement.html">File/Import/Vector Data</a>.<br/>
    You can select an existing or new defined ROI mask to filter which data should be displayed in the plot.<br/>
    (e.g. if you select a water mask, only as water classified raster data are displayed correlative with
    the imported data.)
</p>

<center>
    <img src="images/CorrelativePlot1.png">
</center>


<h4>Options Panel</h4>

<p>
    You can Collapse/Expand the options panel by clicking the button
    <img src="images/icons/PanelRight12.png" border="1"> or <img src="images/icons/PanelLeft12.png" border="1">
    at the top right place on the correlative plot display.
</p>

<p>
    The outcome of the correlative plot can be altered via the options in the options panel.<br>
</p>

<ul>

    <li><b>Refresh View <img src="images/icons/ViewRefresh22.png"></b><br>
        This button is disabled, because it is not needed at the correlative plot. If any value at the options panel
        has changed, the plot will automatically be recomputed.
    </li>

    <li><b>Table View</b> &nbsp;<img src="images/icons/Table24.png"><br>
        Shows the calculated data of the plot in a <a href="CoordinateListView.html">Table View</a> which provides
        information about the data displayed in the plot. From there, you will be able to switch back to
        the correlative plot.
    </li>

    <li><b>ROI Mask</b><br>
        A ROI mask may be used to mask out values. All values which do not match the mask are
        not taken
        into account. For convenience, the mask manager may be openened from the correlative plot
        window using the
        <img src="images/icons/MaskManager24.png">-button.<br>
    </li>

    <li><b>Box Size (Standard deviation)</b><br>
        The error bars, as you can see in the image above, indicate the standard
        deviation (see http://en.wikipedia.org/wiki/Standard_deviation#With_sample_standard_deviation)
        of the correlative raster pixel within a square box. The edge length
        of that square box can be set to any odd value between 1 and 101.
        The selected raster variable is either the one currently selected in
        the <a href="ProductExplorer.html">Product View</a> or the currently selected
        <a href="ProductSceneView.html">Image View</a>.
    </li>

    <li><b>Point Data Source</b><br>
        At this place you have to select the imported reference data. Reference data can be
        imported in several ways.
        See import of <a href="ImportCSV.html">CSV data</a>, <a href="ImportShapefile.html">ESRI Shapefiles</a>,
        <a href="ImportMermaid.html">MERMAID Extraction Files</a> and
        <a href="ImportSeaDASTrack.html">SeaDAS Ship Tracks</a>.
    </li>

    <li><b>Data Field</b><br>
        Select the reference data, which should be displayed correlative to the selected
        raster variable.
    </li>

    <li><b>X-Axis</b> (Reference axis)<br>
        Reference values are assigned along the x-axis. If a reference data column is selected,
        the name of the selected reference data field is displayed in the header-line of the
        x-axis area.
        <ul>
            <li><b>Auto min/max</b><br>
                You can explicitly set the minimum and maximum values to be considered during
                the computation of the correlative plot. To do so, uncheck the checkbox and
                enter the desired min- or max-value. When the checkboxes is checked , min-
                and max-values will be determined automatically.
            </li>
            <li><b>Log10 Scaled</b><br>
                Causes the x-axis to be log10 scaled.
            </li>
        </ul>
    </li>

    <li><b>Y-Axis</b> (Raster axis)<br>
        Raster values are assigned along the y-axis. If a raster value is selected, the name
        of the selected raster value is displayed in the header-line of the y-axis area.
        <ul>
            <li><b>Auto min/max</b><br>
                You can explicitly set the minimum and maximum values to be considered during
                the computation of the correlative plot. To do so, uncheck the checkbox and
                enter the desired min- or max-value. When the checkboxes is checked , min-
                and max-values will be determined automatically.
            </li>
            <li><b>Log10 Scaled</b><br>
                Causes the y-axis to be log10 scaled.
            </li>
        </ul>
    </li>

    <li><b>Show Tolerance Range</b><br>
        Shows the user defined tolerance range as a blue shade along the 1:1 line. The tolerance range is only a
        visualisation tool, which causes no effects to computation.
    </li>

    <li><b>Show Regression Line</b><br>
        Displays a regression line which has been calculated with the ordinary least squares method
        (see http://en.wikipedia.org/wiki/Ordinary_least_squares).
        Also the coefficient of determination (see http://en.wikipedia.org/wiki/Coefficient_of_determination)
        and the linear equation are displayed in the plot.
    </li>

    <li><b>Zoom all <img src="images/icons/View-Fullscreen22.png"></b><br>
        Adjusts both axes to the full data range.
        You can also use the 'Auto range' entry in the context menu.
    </li>

    <li><b>Edit Properties <img src="images/icons/Edit24.gif"></b><br>
        Edit several properties (colors, axes, etc.) of the diagram.
        You can also use the 'Properties...' entry in the context menu.
    </li>

    <li><b>Save chart as image <img src="images/icons/Export24.gif"></b><br>
        Save the diagram as image (PNG).
        You can also use the 'Save as...' entry in the context menu.
    </li>

    <li><b>Print chart <img src="images/icons/Print24.gif"></b><br>
        Print the diagram.
        You can also use the 'Print...' entry in the context menu.
    </li>

    <li><b>Help <img src="images/icons/Help22.png"></b><br>
        Displays this page.
    </li>

</ul>


<h4>Context Menu</h4>

<p>A click with the right mouse button on the diagram brings up a context menu
    which consists of the following menu items:</p>
<ul>
    <li><b>Properties...</b><br>
        Edit several properties (colors, axes, etc.) of the diagram.<br>
        You can also use the <img src="images/icons/Edit24.gif"> on the right 'Plot' panel.
    </li>
    <li><b>Copy</b><br>
        Copies the diagram as image into the clipboard. <br>
    </li>
    <li><b>Save As...</b><br>
        Save the diagram as image (PNG). <br>
        You can also use the <img src="images/icons/Export24.gif"> on the right 'Plot' panel.
    </li>
    <li><b>Print...</b><br>
        Print the diagram.<br>
        You can also use the <img src="images/icons/Print24.gif"> on the right 'Plot' panel.
    </li>
    <li><b>Zoom In</b><br>
        <ul>
            <li>Both Axes - Zoom in on both axes.<br>
                You can also zoom in by drawing a rectangle. Click at the top left corner of your desired zooming area,
                drag to the bottom right corner, and release. Note that this won't work when
                'Select Mask 'scatter_plot_area'' is selected.<br>
                Also you can immediately zoom in/out using the mouse wheel.
            </li>
            <li>Domain Axes - Zoom in only on the domain axis.</li>
            <li>Range Axes - Zoom in only on the range axis.</li>
        </ul>
    </li>
    <li><b>Zoom Out</b><br>
        <ul>
            <li>Both Axes - Zoom out on both axes.<br></li>
            <li>Domain Axes - Zoom out only on the domain axis.</li>
            <li>Range Axes - Zoom out only on the range axis.</li>
        </ul>
    </li>
    <li><b>Auto Range</b><br>
        <ul>
            <li>Both Axes - Adjusts both axes to the full data range.<br>
                You can also use the <img src="images/icons/View-Fullscreen22.png"> on the right 'Plot' panel.
            </li>
            <li>Domain Axes - Adjusts the domain axis to the full data range.</li>
            <li>Range Axes - Adjusts the range axis to the full data range.</li>
        </ul>
    </li>
    <li><b>Select Mask 'correlative_plot_area'</b><br>
        Allows you to create a mask from the correlative plot.
        After selecting the menu entry, you can choose a zone by clicking in the plot, dragging, and releasing.
        The mask will be selected immediately.<br>
        <img src="images/CorrelativePlot2.png">
    </li>
    <li><b>Delete Mask 'correlative_plot_area'</b><br>
        Removes the mask 'correlative_plot_area' (in case you have created it before).
    </li>
    <li><b>Copy Data to Clipboard</b><br>
        This will copy the diagram data as tabulated text to the system clipboard.
        The copied text can then be pasted directly into a spreadsheet application
        (e.g. Microsoft&reg; Excel).
    </li>
</ul>

<hr>
</body>
</html>

<!--page visited by UK-->